<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.net;<a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.EventObject;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /***<a name="line.21"></a>
<FONT color="green">022</FONT>     * There exists a large class of IETF protocols that work by sending an<a name="line.22"></a>
<FONT color="green">023</FONT>     * ASCII text command and arguments to a server, and then receiving an<a name="line.23"></a>
<FONT color="green">024</FONT>     * ASCII text reply.  For debugging and other purposes, it is extremely<a name="line.24"></a>
<FONT color="green">025</FONT>     * useful to log or keep track of the contents of the protocol messages.<a name="line.25"></a>
<FONT color="green">026</FONT>     * The ProtocolCommandEvent class coupled with the<a name="line.26"></a>
<FONT color="green">027</FONT>     * {@link org.apache.commons.net.ProtocolCommandListener}<a name="line.27"></a>
<FONT color="green">028</FONT>     *  interface facilitate this process.<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;p&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>     * @see ProtocolCommandListener<a name="line.31"></a>
<FONT color="green">032</FONT>     * @see ProtocolCommandSupport<a name="line.32"></a>
<FONT color="green">033</FONT>     * @author Daniel F. Savarese<a name="line.33"></a>
<FONT color="green">034</FONT>     ***/<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>    public class ProtocolCommandEvent extends EventObject<a name="line.36"></a>
<FONT color="green">037</FONT>    {<a name="line.37"></a>
<FONT color="green">038</FONT>        private int __replyCode;<a name="line.38"></a>
<FONT color="green">039</FONT>        private boolean __isCommand;<a name="line.39"></a>
<FONT color="green">040</FONT>        private String __message, __command;<a name="line.40"></a>
<FONT color="green">041</FONT>    <a name="line.41"></a>
<FONT color="green">042</FONT>        /***<a name="line.42"></a>
<FONT color="green">043</FONT>         * Creates a ProtocolCommandEvent signalling a command was sent to<a name="line.43"></a>
<FONT color="green">044</FONT>         * the server.  ProtocolCommandEvents created with this constructor<a name="line.44"></a>
<FONT color="green">045</FONT>         * should only be sent after a command has been sent, but before the<a name="line.45"></a>
<FONT color="green">046</FONT>         * reply has been received.<a name="line.46"></a>
<FONT color="green">047</FONT>         * &lt;p&gt;<a name="line.47"></a>
<FONT color="green">048</FONT>         * @param source  The source of the event.<a name="line.48"></a>
<FONT color="green">049</FONT>         * @param command The string representation of the command type sent, not<a name="line.49"></a>
<FONT color="green">050</FONT>         *      including the arguments (e.g., "STAT" or "GET").<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param message The entire command string verbatim as sent to the server,<a name="line.51"></a>
<FONT color="green">052</FONT>         *        including all arguments.<a name="line.52"></a>
<FONT color="green">053</FONT>         ***/<a name="line.53"></a>
<FONT color="green">054</FONT>        public ProtocolCommandEvent(Object source, String command, String message)<a name="line.54"></a>
<FONT color="green">055</FONT>        {<a name="line.55"></a>
<FONT color="green">056</FONT>            super(source);<a name="line.56"></a>
<FONT color="green">057</FONT>            __replyCode = 0;<a name="line.57"></a>
<FONT color="green">058</FONT>            __message = message;<a name="line.58"></a>
<FONT color="green">059</FONT>            __isCommand = true;<a name="line.59"></a>
<FONT color="green">060</FONT>            __command = command;<a name="line.60"></a>
<FONT color="green">061</FONT>        }<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>        /***<a name="line.64"></a>
<FONT color="green">065</FONT>         * Creates a ProtocolCommandEvent signalling a reply to a command was<a name="line.65"></a>
<FONT color="green">066</FONT>         * received.  ProtocolCommandEvents created with this constructor<a name="line.66"></a>
<FONT color="green">067</FONT>         * should only be sent after a complete command reply has been received<a name="line.67"></a>
<FONT color="green">068</FONT>         * fromt a server.<a name="line.68"></a>
<FONT color="green">069</FONT>         * &lt;p&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>         * @param source  The source of the event.<a name="line.70"></a>
<FONT color="green">071</FONT>         * @param replyCode The integer code indicating the natureof the reply.<a name="line.71"></a>
<FONT color="green">072</FONT>         *   This will be the protocol integer value for protocols<a name="line.72"></a>
<FONT color="green">073</FONT>         *   that use integer reply codes, or the reply class constant<a name="line.73"></a>
<FONT color="green">074</FONT>         *   corresponding to the reply for protocols like POP3 that use<a name="line.74"></a>
<FONT color="green">075</FONT>         *   strings like OK rather than integer codes (i.e., POP3Repy.OK).<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param message The entire reply as received from the server.<a name="line.76"></a>
<FONT color="green">077</FONT>         ***/<a name="line.77"></a>
<FONT color="green">078</FONT>        public ProtocolCommandEvent(Object source, int replyCode, String message)<a name="line.78"></a>
<FONT color="green">079</FONT>        {<a name="line.79"></a>
<FONT color="green">080</FONT>            super(source);<a name="line.80"></a>
<FONT color="green">081</FONT>            __replyCode = replyCode;<a name="line.81"></a>
<FONT color="green">082</FONT>            __message = message;<a name="line.82"></a>
<FONT color="green">083</FONT>            __isCommand = false;<a name="line.83"></a>
<FONT color="green">084</FONT>            __command = null;<a name="line.84"></a>
<FONT color="green">085</FONT>        }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>        /***<a name="line.87"></a>
<FONT color="green">088</FONT>         * Returns the string representation of the command type sent (e.g., "STAT"<a name="line.88"></a>
<FONT color="green">089</FONT>         * or "GET").  If the ProtocolCommandEvent is a reply event, then null<a name="line.89"></a>
<FONT color="green">090</FONT>         * is returned.<a name="line.90"></a>
<FONT color="green">091</FONT>         * &lt;p&gt;<a name="line.91"></a>
<FONT color="green">092</FONT>         * @return The string representation of the command type sent, or null<a name="line.92"></a>
<FONT color="green">093</FONT>         *         if this is a reply event.<a name="line.93"></a>
<FONT color="green">094</FONT>         ***/<a name="line.94"></a>
<FONT color="green">095</FONT>        public String getCommand()<a name="line.95"></a>
<FONT color="green">096</FONT>        {<a name="line.96"></a>
<FONT color="green">097</FONT>            return __command;<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>        /***<a name="line.101"></a>
<FONT color="green">102</FONT>         * Returns the reply code of the received server reply.  Undefined if<a name="line.102"></a>
<FONT color="green">103</FONT>         * this is not a reply event.<a name="line.103"></a>
<FONT color="green">104</FONT>         * &lt;p&gt;<a name="line.104"></a>
<FONT color="green">105</FONT>         * @return The reply code of the received server reply.  Undefined if<a name="line.105"></a>
<FONT color="green">106</FONT>         *         not a reply event.<a name="line.106"></a>
<FONT color="green">107</FONT>         ***/<a name="line.107"></a>
<FONT color="green">108</FONT>        public int getReplyCode()<a name="line.108"></a>
<FONT color="green">109</FONT>        {<a name="line.109"></a>
<FONT color="green">110</FONT>            return __replyCode;<a name="line.110"></a>
<FONT color="green">111</FONT>        }<a name="line.111"></a>
<FONT color="green">112</FONT>    <a name="line.112"></a>
<FONT color="green">113</FONT>        /***<a name="line.113"></a>
<FONT color="green">114</FONT>         * Returns true if the ProtocolCommandEvent was generated as a result<a name="line.114"></a>
<FONT color="green">115</FONT>         * of sending a command.<a name="line.115"></a>
<FONT color="green">116</FONT>         * &lt;p&gt;<a name="line.116"></a>
<FONT color="green">117</FONT>         * @return true If the ProtocolCommandEvent was generated as a result<a name="line.117"></a>
<FONT color="green">118</FONT>         * of sending a command.  False otherwise.<a name="line.118"></a>
<FONT color="green">119</FONT>         ***/<a name="line.119"></a>
<FONT color="green">120</FONT>        public boolean isCommand()<a name="line.120"></a>
<FONT color="green">121</FONT>        {<a name="line.121"></a>
<FONT color="green">122</FONT>            return __isCommand;<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>        /***<a name="line.125"></a>
<FONT color="green">126</FONT>         * Returns true if the ProtocolCommandEvent was generated as a result<a name="line.126"></a>
<FONT color="green">127</FONT>         * of receiving a reply.<a name="line.127"></a>
<FONT color="green">128</FONT>         * &lt;p&gt;<a name="line.128"></a>
<FONT color="green">129</FONT>         * @return true If the ProtocolCommandEvent was generated as a result<a name="line.129"></a>
<FONT color="green">130</FONT>         * of receiving a reply.  False otherwise.<a name="line.130"></a>
<FONT color="green">131</FONT>         ***/<a name="line.131"></a>
<FONT color="green">132</FONT>        public boolean isReply()<a name="line.132"></a>
<FONT color="green">133</FONT>        {<a name="line.133"></a>
<FONT color="green">134</FONT>            return !isCommand();<a name="line.134"></a>
<FONT color="green">135</FONT>        }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>        /***<a name="line.137"></a>
<FONT color="green">138</FONT>         * Returns the entire message sent to or received from the server.<a name="line.138"></a>
<FONT color="green">139</FONT>         * &lt;p&gt;<a name="line.139"></a>
<FONT color="green">140</FONT>         * @return The entire message sent to or received from the server.<a name="line.140"></a>
<FONT color="green">141</FONT>         ***/<a name="line.141"></a>
<FONT color="green">142</FONT>        public String getMessage()<a name="line.142"></a>
<FONT color="green">143</FONT>        {<a name="line.143"></a>
<FONT color="green">144</FONT>            return __message;<a name="line.144"></a>
<FONT color="green">145</FONT>        }<a name="line.145"></a>
<FONT color="green">146</FONT>    }<a name="line.146"></a>




























































</PRE>
</BODY>
</HTML>
